您的 API 变更可能会影响您的集成
变更场景
在对您的 API 进行变更时,请考虑这些变更将如何影响您的 Zapier 集成。API 更新可能从小型变更到重大变更不等,并会对您的用户 Zap 产生不同影响。
对用户的影响
虽然并非详尽无遗,以下是一些潜在的重大影响:
- 如果推广了带有身份验证破坏性变更的新版本,拥有现有 Zap 的用户将需要在 Zapier 上手动重新连接他们的账户。
- 如果推广了带有任何触发器、操作或搜索破坏性变更的新版本,拥有现有 Zap 的用户将需要手动升级_每个_使用您的集成的 Zap。请记住:高级用户可能拥有数十到数百个 Zap 使用您的集成。
- 对触发器、操作或搜索的响应数据进行变更,可能会导致 Zap 的后续步骤中断或产生负面影响。
- 对轮询触发器的响应数据进行变更,可能会导致 Zap 无法正确触发新记录,或意外触发旧记录。这可能导致用户错过数据,并带来不良结果。
最佳实践
为减轻 API 变更对 Zapier 用户的影响,请考虑以下最佳实践:
- 保持现有端点的总体向后兼容性。这能确保现有 Zap 继续正常运行,用户无需因 API 变更而进行修改。
- 对于轮询触发器——更改端点返回的记录数量可能会显著影响用户 Zap 的功能。
- 在端点上实现分页可能会影响 Zap 轮询该端点时获取和处理的数据量。
- 更改响应数据的排序顺序可能会影响 Zap 触发器。对于轮询触发器,请确保数据始终按逆时序排序,以维护兼容性。
通过遵循这些最佳实践,您可以在更新或修改 API 时,将对 Zapier 用户的干扰降到最低。一个管理良好的 API 过渡过程,能确保您的用户继续享受到顺畅且高效的 Zapier 集成体验。